home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / rmail41.zip / READMAIL.DOC < prev    next >
Text File  |  1993-08-18  |  39KB  |  960 lines
  1.  
  2.                               * READMAIL 4.1 *
  3.  
  4.                          A message reader for the PC
  5.  
  6.                                  Written by
  7.                                Jeroen Schipper
  8.  
  9.  
  10.     This manual is in Unix mailbox format, so you can read this manual
  11.     with the program READMAIL.EXE using the Unix header definition.
  12.     At the DOS prompt, enter:
  13.  
  14.     C>READMAIL.EXE READMAIL.DOC /P
  15.  
  16.     The /P will enable auto detection.
  17.  
  18.  
  19. ---------Start of messages--------
  20.  
  21. From jschipper@hut.nl Tue Aug 17 12:52 CET 1993
  22. Received: by hut.nl
  23. From: Jeroen Schipper <jschipper@hut.nl>
  24. Return-path: <jschipper@hut.nl>
  25. Message-Id: <M8872H@JJS8.882J2J>
  26. Subject: Introduction
  27. To: you@at.your.terminal
  28. Date: Tue 17, Aug 93 12:52
  29. Status: RO
  30.  
  31.     Thank you for trying ReadMail!
  32.  
  33.     ReadMail is a message reader for the PC with many options. It can be
  34.     used to scan your message files or mailbox files containing multiple
  35.     messages. You can use ReadMail to make an easy selection of messages 
  36.     you want to read, delete or print. Bookmarks can be used to keep track
  37.     of messages you have read. ReadMail is an easy-to-use program, help
  38.     screens are available for every function.
  39.  
  40.     This program can be used as an off-line mail reader for most bbs-
  41.     systems, provided the header definition is setup correctly.
  42.  
  43.     Please notice: This program is NOT A MAILER! You cannot send new
  44.     messages with this program or read messages on-line.
  45.  
  46. From jschipper@hut.nl Tue Aug 17 12:52 CET 1993
  47. Received: by hut.nl
  48. From: Jeroen Schipper <jschipper@hut.nl>
  49. Return-path: <jschipper@hut.nl>
  50. Message-Id: <M8872H@JJS8.882J2J>
  51. Subject: What's in the archive?
  52. To: you@at.your.terminal
  53. Date: Tue 17, Aug 93 12:52
  54. Status: RO
  55.  
  56.     The archive file RMAIL41.* must contain the following files:
  57.  
  58.       - READMAIL.EXE    - The main program
  59.       - READMAIL.DOC    - Sample message file and at the same time the
  60.                           instructions
  61.  
  62.     That's all!
  63.  
  64.     A setup file will be created. The setup file contains your color setup
  65.     and some additional information about the configuration. This file
  66.     also contains the message definitions (see below).
  67.     The setup file must be in your current directory, or the directory
  68.     where READMAIL.EXE was started from. You can also specify a setup
  69.     file from the commandline, which is especially handy if more users
  70.     on a network use ReadMail.
  71.  
  72. From jschipper@hut.nl Tue Aug 17 12:52 CET 1993
  73. Received: by hut.nl
  74. From: Jeroen Schipper <jschipper@hut.nl>
  75. Return-path: <jschipper@hut.nl>
  76. Message-Id: <M8872H@JJS8.882J2J>
  77. Subject: Valid message files
  78. To: you@at.your.terminal
  79. Date: Tue 17, Aug 93 12:52
  80. Status: RO
  81.  
  82.     A message file is a text file that contains messages which are sepa-
  83.     rated by headers. The header definition can be changed (See Creating
  84.     new message types). The header definition should at least contain a
  85.     subject, other fields are not necessary.
  86.  
  87.     ReadMail requires DOS 3.x or higher.
  88.  
  89.     DOS vs UNIX
  90.     ===========
  91.  
  92.     ReadMail can handle both Dos and Unix files. The only difference is
  93.     that Dos uses both a <CR> (carriage return) and a <LF> (linefeed) as
  94.     an end of line, while Unix only has a <LF>.
  95.  
  96.     NUMBER OF MESSAGES
  97.     ==================
  98.  
  99.     READMAIL can read up to 900 messages if there is enough memory. If
  100.     your files contains more messages than the maximum (use [F5] to see
  101.     maximum) they will be ignored. The messages will be sorted on subject,
  102.     sender or will not be sorted at all (can be changed in setup).
  103.  
  104. From jschipper@hut.nl Tue Aug 17 12:52 CET 1993
  105. Received: by hut.nl
  106. From: Jeroen Schipper <jschipper@hut.nl>
  107. Return-path: <jschipper@hut.nl>
  108. Message-Id: <M8872H@JJS8.882J2J>
  109. Subject: Scanning multiple files
  110. To: you@at.your.terminal
  111. Date: Tue 17, Aug 93 12:52
  112. Status: RO
  113.  
  114.     When you enter the filename of the message file, you can use DOS-
  115.     wildcards to scan multiple files. However, all files must have the
  116.     same message type. All found messages will be displayed in one big
  117.     list in the selection screen. The top of the screen shows the filename
  118.     where the current message was found. You also can press [F5] (status
  119.     display) to see the current OPEN file. This is not always the same
  120.     file as the current message (e.g. when not in preview mode.) When
  121.     reading messages, [F5] always gives the right filename.
  122.  
  123.     If you set sorting method ([S]) to Don't Sort, all messages will be in
  124.     the order in which they were read. So all messages found in 1 file
  125.     will be grouped together. This is also the closest you can get to sort
  126.     messages on date, ReadMail cannot sort on the date field, because of
  127.     the many different conventions, different languages, used by mailers
  128.     for the date field.
  129.  
  130. From jschipper@hut.nl Tue Aug 17 12:52 CET 1993
  131. Received: by hut.nl
  132. From: Jeroen Schipper <jschipper@hut.nl>
  133. Return-path: <jschipper@hut.nl>
  134. Message-Id: <M8872H@JJS8.882J2J>
  135. Subject: Creating new message types
  136. To: you@at.your.terminal
  137. Date: Tue 17, Aug 93 12:52
  138. Status: RO
  139.  
  140.     You can use ReadMail to read different message files. To do this, you
  141.     must define the header, so ReadMail can recognize a new message. To
  142.     define a new header, press [F8] when you are prompted for a filename
  143.     or when you are in the selection screen. You see a list of 15 defini-
  144.     tions you can define. By default, the first seven are defined as:
  145.  
  146.     [A] Unix
  147.     [B] EchoMail
  148.     [C] Prof. Timo Salmi's FAQ Lists
  149.     [D] MBBS
  150.     [E] MMDF mail system
  151.     [F] UseNet messages
  152.     [G] CompuServe forum
  153.  
  154.     The top message can never be deleted; others can be deleted by
  155.     removing the description. All definitions can be modified by pressing
  156.     [ALT] + the corresponding key (e.g. to change the third one, press
  157.     [ALT-C]). Now you can define the header. In some of the fields you may
  158.     use wildcards. The wildcards recognized by ReadMail are:
  159.  
  160.     *   Replaces any string, even an empty one
  161.     ?   Replaces exactly one character
  162.  
  163.     However if you need a "real" * or ? in a field not to be used as a
  164.     wildcard, preceed the wildcard with a backslash ("\"). So:
  165.  
  166.     \*  Replaces "*"
  167.     \?  Replaces "?"
  168.  
  169.     For demonstration on how to use the wildcards, see the examples below.
  170.     In all fields, you can use "low" and "high" ascii characters by using
  171.     "#nnn". For instance to insert a "╘" (=ASCII 212) enter #212. To
  172.     insert Control characters, use the same method: To insert a Control-D
  173.     (=ASCII 004), enter #4.
  174.  
  175.     Here is an overview of the fields to be filled out. Only the
  176.     description, new header and subject are required, other fields are
  177.     optional.
  178.  
  179.     1. Description
  180.  
  181.     This is the description used in the selection list.
  182.  
  183.     2. New Header (Wildcards allowed)
  184.  
  185.     This is where the line is defined that starts a new header in your
  186.     message files. It is essential that you define this as precise as
  187.     possible, so that ReadMail won't recognize a random line as a header.
  188.  
  189.     3. End Header (Wildcards allowed)
  190.  
  191.     Here you define where the header ends and the message body begins.
  192.     There are two possibilities:
  193.  
  194.     - The header ends with a string: enter this string (if necessary use
  195.       wildcards). If the header ends with a blank line then enter nothing.
  196.     - The header has a fixed number of lines: enter the number of lines
  197.  
  198.  
  199.     4. Subject (Wildcards not allowed)
  200.  
  201.     To find the subject, ReadMail must know what to look for in the
  202.     header. Enter only the keyword that is always the same at the begin-
  203.     ning of the line. Wildcards are not allowed here, except a * as the
  204.     first character of the line. Uppercase or lowercase is also important:
  205.     the keyword shall match exactly the subject name. If the subject is
  206.     always at the same offset from the beginning of the header, you can
  207.     also enter the line number. In this case the whole line will be read
  208.     as the subject.
  209.  
  210.     5. End Subject (One wildcard allowed at the end)
  211.  
  212.     If the subject is f